package org.dromara.common.core.utils;

import cn.hutool.core.convert.Convert;
import cn.hutool.extra.servlet.JakartaServletUtil;
import cn.hutool.http.HttpStatus;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.springframework.http.MediaType;
import org.springframework.util.LinkedCaseInsensitiveMap;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import java.io.IOException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：客户端工具类
 */
/**
 * ServletUtils 类是 JakartaServletUtil 的扩展，提供了一些便利方法和工具，
 * 用于简化 Servlet 相关操作。该类主要目的是为了提高代码的可读性和可维护性，
 * 并封装了一些常用的 Servlet 操作逻辑。
 */
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class ServletUtils extends JakartaServletUtil {

    /**
     * 获取String参数
     *
     * @param name 参数名称
     * @return 参数值，如果未获取到则返回null
     */
    public static String getParameter(String name) {
        return getRequest().getParameter(name);
    }

    /**
     * 获取String参数，如果未获取到则返回默认值
     *
     * @param name 参数名称
     * @param defaultValue 默认值
     * @return 参数值，如果未获取到则返回默认值
     */
    public static String getParameter(String name, String defaultValue) {
        return Convert.toStr(getRequest().getParameter(name), defaultValue);
    }

    /**
     * 获取Integer参数
     *
     * @param name 参数名称
     * @return 参数值，如果未获取到或转换失败则返回null
     */
    public static Integer getParameterToInt(String name) {
        return Convert.toInt(getRequest().getParameter(name));
    }

    /**
     * 获取Integer参数，如果未获取到或转换失败则返回默认值
     *
     * @param name 参数名称
     * @param defaultValue 默认值
     * @return 参数值，如果未获取到或转换失败则返回默认值
     */
    public static Integer getParameterToInt(String name, Integer defaultValue) {
        return Convert.toInt(getRequest().getParameter(name), defaultValue);
    }

    /**
     * 获取Boolean参数
     * @param name 参数名称
     * @return 参数值，如果未获取到或转换失败则返回null
     */
    public static Boolean getParameterToBool(String name) {
        return Convert.toBool(getRequest().getParameter(name));
    }

    /**
     * 获取Boolean参数，如果未获取到或转换失败则返回默认值
     *
     * @param name 参数名称
     * @param defaultValue 默认值
     * @return 参数值，如果未获取到或转换失败则返回默认值
     */
    public static Boolean getParameterToBool(String name, Boolean defaultValue) {
        return Convert.toBool(getRequest().getParameter(name), defaultValue);
    }

    /**
     * 获得所有请求参数
     * 本方法通过直接返回请求对象中的参数映射，提供了一个不可修改的参数映射视图这避免了外部修改参数的风险，
     * 确保了参数数据的一致性和安全。
     *
     * @param request 请求对象{@link ServletRequest}
     * @return Map 包含所有请求参数的不可修改映射
     */
    public static Map<String, String[]> getParams(ServletRequest request) {
        final Map<String, String[]> map = request.getParameterMap();
        // 将参数映射转换为不可修改视图，增强安全性
        return Collections.unmodifiableMap(map);
    }

    /**
     * 获得所有请求参数
     * 获取请求参数并将其转换为Map形式
     *
     * 该方法将ServletRequest对象中的请求参数转换为Map<String, String>的形式
     * 其中，参数名作为键，参数值数组通过特定分隔符连接后作为值
     * 这样处理后，方便使用参数名快速获取其对应的值
     *
     * @param request 请求对象{@link ServletRequest}，包含请求参数信息
     * @return Map 包含请求参数的Map，键为参数名，值为参数值字符串
     */
    public static Map<String, String> getParamMap(ServletRequest request) {
        Map<String, String> params = new HashMap<>();
        // 遍历请求中的参数，将参数名和通过特定分隔符连接的参数值存入params Map中
        for (Map.Entry<String, String[]> entry : getParams(request).entrySet()) {
            params.put(entry.getKey(), StringUtils.join(entry.getValue(), StringUtils.SEPARATOR));
        }
        return params;
    }

    /**
     * 获取request
     *
     * @return 返回HttpServletRequest对象，如果出现异常则返回null
     */
    public static HttpServletRequest getRequest() {
        try {
            return getRequestAttributes().getRequest();
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 获取response
     *
     * @return 返回HttpSession对象
     */
    public static HttpServletResponse getResponse() {
        try {
            return getRequestAttributes().getResponse();
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 获取session
     */
    public static HttpSession getSession() {
        return getRequest().getSession();
    }

    /**
     * 获取当前请求的ServletRequestAttributes对象
     *
     * @return ServletRequestAttributes对象，如果无法获取当前请求或者转换失败，则返回null
     */
    public static ServletRequestAttributes getRequestAttributes() {
        try {
            RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
            return (ServletRequestAttributes) attributes;
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 获取请求头信息
     *
     * @param request 请求对象，用于获取请求头
     * @param name 请求头的名称
     * @return 返回请求头的值，如果该请求头不存在或值为空，则返回空字符串
     */
    public static String getHeader(HttpServletRequest request, String name) {
        // 通过请求对象获取指定名称的请求头的值
        String value = request.getHeader(name);
        // 如果请求头的值为空或不存在，则返回空字符串
        if (StringUtils.isEmpty(value)) {
            return StringUtils.EMPTY;
        }
        // 对请求头的值进行URL解码，以处理可能的特殊字符编码问题
        return urlDecode(value);
    }

    /**
     * 获取请求中的所有头部信息
     *
     * 此方法通过遍历HttpServletRequest请求对象，提取并返回所有请求头部信息的映射
     * 使用LinkedCaseInsensitiveMap保持键的插入顺序，并忽略键的大小写
     *
     * @param request HttpServletRequest请求对象，用于提取头部信息
     * @return 包含所有头部信息的映射，键为头部名称，值为头部对应的值
     */
    public static Map<String, String> getHeaders(HttpServletRequest request) {
        // 创建一个不区分大小写且保持插入顺序的映射，用于存储头部信息
        // key 头部名称 value 头部名称的值
        Map<String, String> map = new LinkedCaseInsensitiveMap<>();
        // 获取请求中所有头部名称的枚举
        Enumeration<String> enumeration = request.getHeaderNames();
        // 检查是否有头部信息
        if (enumeration != null) {
            // 遍历所有的头部名称
            while (enumeration.hasMoreElements()) {
                // 获取下一个头部名称
                String key = enumeration.nextElement();
                // 获取对应头部名称的值
                String value = request.getHeader(key);
                // 将头部名称和值存入映射中
                map.put(key, value);
            }
        }
        // 返回包含所有头部信息的映射
        return map;
    }

    /**
     * 将字符串渲染到客户端
     * 将指定字符串渲染到HttpServletResponse中
     * 该方法准备响应对象，设置其状态、内容类型和字符编码，然后将字符串写入响应流
     *
     * @param response 渲染对象 HttpServletResponse对象，用于向客户端发送响应
     * @param string   待渲染的字符串 需要渲染到客户端的字符串
     */
    public static void renderString(HttpServletResponse response, String string) {
        try {
            // 设置响应状态为HTTP OK
            response.setStatus(HttpStatus.HTTP_OK);
            // 设置响应内容类型为JSON格式
            response.setContentType(MediaType.APPLICATION_JSON_VALUE);
            // 设置响应字符编码为UTF-8
            response.setCharacterEncoding(StandardCharsets.UTF_8.toString());
            // 获取响应的输出流并打印字符串
            response.getWriter().print(string);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 是否是Ajax异步请求
     *
     * @param request 请求对象
     * @return 如果是AJAX请求返回true，否则返回false
     */
    public static boolean isAjaxRequest(HttpServletRequest request) {
        // 检查请求头中的Accept字段，看是否为JSON类型
        String accept = request.getHeader("accept");
        if (accept != null && accept.contains(MediaType.APPLICATION_JSON_VALUE)) {
            return true;
        }

        // 检查请求头中的X-Requested-With字段，看是否为XMLHttpRequest类型
        String xRequestedWith = request.getHeader("X-Requested-With");
        if (xRequestedWith != null && xRequestedWith.contains("XMLHttpRequest")) {
            return true;
        }

        // 检查请求的URI，看是否以.json或.xml结尾
        String uri = request.getRequestURI();
        if (StringUtils.equalsAnyIgnoreCase(uri, ".json", ".xml")) {
            return true;
        }

        // 检查请求参数中的__ajax字段，看是否为json或xml
        String ajax = request.getParameter("__ajax");
        return StringUtils.equalsAnyIgnoreCase(ajax, "json", "xml");
    }

    /**
     * 获取客户端IP地址
     *
     * 通过调用getClientIP方法，并传入当前请求对象，来获取客户端的IP地址
     * 此方法主要用于识别用户的真实IP，以便进行地理位置相关的操作或安全控制
     *
     * @return 客户端IP地址的字符串形式
     */
    public static String getClientIP() {
        return getClientIP(getRequest());
    }

    /**
     * 内容编码
     *
     * @param str 内容
     * @return 编码后的内容
     */
    public static String urlEncode(String str) {
        return URLEncoder.encode(str, StandardCharsets.UTF_8);
    }

    /**
     * 内容解码
     *
     * @param str 内容
     * @return 解码后的内容
     */
    public static String urlDecode(String str) {
        return URLDecoder.decode(str, StandardCharsets.UTF_8);
    }

}
